Skip to main content

vpnCreate

Description

Vpn creation.

Request Method

POST

Request Path

/customer/vpn/create

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
periodBODYintegerNoNo sample value for this parameter.period
costBODYnumberNoNo sample value for this parameter.cost
bandwidthBODYintegerYesNo sample value for this parameter.bandwidth
gatewayNameBODYstringYesNo sample value for this parameter.gateway name
billingMethodBODYstringYesNo sample value for this parameter.billing method
voucherInstanceIdBODYstringNoNo sample value for this parameter.voucher of the order
couponInstanceIdBODYstringNoNo sample value for this parameter.coupon of the order
sslVpnBODYbooleanYesNo sample value for this parameter.enable ssl
sslConnectionBODYintegerNoNo sample value for this parameter.ssl connections
regionIdBODYstringYesNo sample value for this parameter.region id
vSwitchIdBODYstringNoNo sample value for this parameter.vSwitchId
vpcIdBODYstringYesNo sample value for this parameter.vpcId
pricingCycleBODYstringNoNo sample value for this parameter.pricingCycle ,eg Month、Year
ipSecVpnBODYbooleanYesNo sample value for this parameter.enable IPsec

Return data

NameTypeSample valueDescription
resultobject`{"instanceId":"vpn-2022072618493400001","orderId":2.02207261849340006E+18}`No description for this parameter.
resultCodestring0No description for this parameter.
resultMsgstringsuccessNo description for this parameter.

Example

Successful Response example

{
"result":
{
"instanceId":"vpn-2022072618493400001",
"orderId":2.02207261849340006E+18
},
"resultCode":"0",
"resultMsg":"success"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}